<!DOCTYPE HTML><html><head><title>SLL Service Catalogue Capacity Service API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/kevinrenskers/raml2html 1.6.0"><link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="http://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript">
        $(document).ready(function() {
            $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
                hljs.highlightBlock(block);
            });

            $('[data-toggle]').click(function() {
                var selector = $(this).data('target') + ' pre code';
                $(selector).each(function(i, block) {
                    hljs.highlightBlock(block);
                });
            });
            
            
            // open modal on hashes like #_action_get
            $(window).bind('hashchange', function(e) {
                var anchor_id = document.location.hash.substr(1); //strip #
                var element = $('#' + anchor_id);

                // do we have such element + is it a modal?  --> show it
                if (element.length && element.hasClass('modal')) {
                    element.modal('show');
                }
            });

            // execute hashchange on first page load
            $(window).trigger('hashchange');
            
            // remove url fragment on modal hide
            $('.modal').on('hidden.bs.modal', function() {
                if(history && history.replaceState) { 
                    history.replaceState({}, '', '#');
                }
            });
        });
    </script><style>
        .hljs {
            background: transparent;
        }
        .parent {
            color: #999;
        }
        .list-group-item > .badge {
            float: none;
            margin-right: 6px;
        }
        .panel-title > .methods {
            float: right;
        }
        .badge {
            border-radius: 0;
            text-transform: uppercase;
            width: 70px;
            font-weight: normal;
            color: #f3f3f6;
            line-height: normal;
        }
        .badge_get {
            background-color: #63a8e2;
        }
        .badge_post {
            background-color: #6cbd7d;
        }
        .badge_put {
            background-color: #22bac4;
        }
        .badge_delete {
            background-color: #d26460;
        }
        .badge_patch {
            background-color: #ccc444;
        }
        .list-group, .panel-group {
            margin-bottom: 0;
        }
        .panel-group .panel+.panel-white {
            margin-top: 0;
        }
        .panel-group .panel-white {
            border-bottom: 1px solid #F5F5F5;
            border-radius: 0;
        }
        .panel-white:last-child {
            border-bottom-color: white;
            -webkit-box-shadow: none;
            box-shadow: none;
        }
        .panel-white .panel-heading {
            background: white;
        }
        .tab-pane ul {
            padding-left: 2em;
        }
        .tab-pane h2 {
            font-size: 1.2em;
            padding-bottom: 4px;
            border-bottom: 1px solid #ddd;
        }
        .tab-pane h3 {
            font-size: 1.1em;
        }
        .tab-content {
            border-left: 1px solid #ddd;
            border-right: 1px solid #ddd;
            border-bottom: 1px solid #ddd;
            padding: 10px;
        }
        #sidebar {
            margin-top: 30px;
            padding-right: 5px;
            overflow: auto;
            height: 90%;
        }
        .top-resource-description {
            border-bottom: 1px solid #ddd;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description {
            border-bottom: 1px solid #fcfcfc;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description p:last-child {
            margin: 0;
        }
        .list-group .badge {
            float: left;
        }
        .method_description {
            margin-left: 85px;
        }
        .method_description p:last-child {
            margin: 0;
        }
        .list-group-item {
            cursor: pointer;
        }
        .list-group-item:hover {
            background-color: #f5f5f5;
        }
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>SLL Service Catalogue Capacity Service API documentation <small>version 1.0</small></h1><p>http://localhost:8080/capacity</p><h3 id="General-API-information"><a href="#General-API-information">General API information</a></h3><p>TODO! Description of the Capacity Service Functions</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_capacity" class="panel-title">CapacityService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Service for creating, updating, reading capacities.</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__capacity"><span class="parent"></span>/capacity</a> <span class="methods"><a href="#_capacity_get"><span class="badge badge_get">get</span></a> <a href="#_capacity_post"><span class="badge badge_post">post</span></a> <a href="#_capacity_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel__capacity" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_capacity_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get all stored capacities, grouped by Care Units and Products</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_capacity_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new capacity</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_capacity_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update a capacity</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/capacity</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get all stored capacities, grouped by Care Units and Products</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of Care Unit references",
    "items": { "$ref":"careUnitReference" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><p>Uh Oh, spaghetti-o!</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "A generic service exception for returning when an exception has occurred.",
  "properties": {
    "code": { "type": "string", "required": true },
    "data": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "code" : "INVALID_DAYS_FROM_NOW_RANGE",
  "data" :
    {
      "14"
    }
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/capacity</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new capacity</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity_post_request" data-toggle="tab">Request</a></li><li><a href="#_capacity_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A single Care Unit",
    "properties": {
        "hsaID": { "type": "string", "required": true },
        "product": { "type": "string", "required": true },
        "code": { "type": "string", "required": true },
        "codeSystem": { "type": "string", "required": true },
        "value": { "type": "string", "required": true },
        "validTo": { "type": "string", "format": "date-time", "required": true }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID" : "SE2321000016-1HF3",
  "product" : "???",
  "code" : "1",
  "codeSystem" : "oid.sll.vantetider",
  "value" : "18",
  "validTo" : "1427410800000"
}
</code></pre></div><div class="tab-pane" id="_capacity_post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>Creation successful.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity_put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent"></span>/capacity</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a capacity</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity_put_request" data-toggle="tab">Request</a></li><li><a href="#_capacity_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity_put_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A single Care Unit",
    "properties": {
        "hsaID": { "type": "string", "required": true },
        "product": { "type": "string", "required": true },
        "code": { "type": "string", "required": true },
        "codeSystem": { "type": "string", "required": true },
        "value": { "type": "string", "required": true },
        "validTo": { "type": "string", "format": "date-time", "required": true }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID" : "SE2321000016-1HF3",
  "product" : "???",
  "code" : "1",
  "codeSystem" : "oid.sll.vantetider",
  "value" : "18",
  "validTo" : "1427410800000"
}
</code></pre></div><div class="tab-pane" id="_capacity_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Update successful.</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__capacity__hsaId_"><span class="parent">/capacity</span>/{hsaId}</a> <span class="methods"><a href="#_capacity__hsaId__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__capacity__hsaId_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Service for managing the capacity information for a specific care unit HSA-id.</p></div><div class="list-group"><div onclick="window.location.href = '#_capacity__hsaId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads all capacities belonging to a specific Care Unit</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity__hsaId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/capacity</span>/{hsaId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads all capacities belonging to a specific Care Unit</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity__hsaId__get_request" data-toggle="tab">Request</a></li><li><a href="#_capacity__hsaId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity__hsaId__get_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list capacity information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_capacity__hsaId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of Care Unit references",
    "items": { "$ref":"careUnitReference" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__capacity_byunitids"><span class="parent">/capacity</span>/byunitids</a> <span class="methods"><a href="#_capacity_byunitids_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__capacity_byunitids" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>List all capacities for an incoming list of Care Units HSA-id:s</p></div><div class="list-group"><div onclick="window.location.href = '#_capacity_byunitids_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity_byunitids_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/capacity</span>/byunitids</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_capacity_byunitids_post_request" data-toggle="tab">Request</a></li><li><a href="#_capacity_byunitids_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity_byunitids_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of UnitIds",
  "properties": {
    "units": { 
      "type": "array",
      "items": { "$ref": "unit" }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
    "units": [
        {
            "unitId": "SE2321000016-14VK"
        },
        {
            "unitId": "SE2321000016-3M0N"
        }
    ]
}
</code></pre></div><div class="tab-pane" id="_capacity_byunitids_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of Care Unit references",
    "items": { "$ref":"careUnitReference" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__capacity__hsaId___product___code_"><span class="parent">/capacity</span>/{hsaId}/{product}/{code}</a> <span class="methods"><a href="#_capacity__hsaId___product___code__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel__capacity__hsaId___product___code_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Service for handling a specific combination of Hsa-id, Product and Code.</p></div><div class="list-group"><div onclick="window.location.href = '#_capacity__hsaId___product___code__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete capacities for a specific combination of unitId, product and code.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity__hsaId___product___code__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/capacity</span>/{hsaId}/{product}/{code}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete capacities for a specific combination of unitId, product and code.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity__hsaId___product___code__delete_request" data-toggle="tab">Request</a></li><li><a href="#_capacity__hsaId___product___code__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity__hsaId___product___code__delete_request"><h3>URI Parameters</h3><ul><li><strong>The care unit Hsa Id to filter for</strong>: <em>required (string )</em></li><li><strong>The product code to filter fort</strong>: <em>required (string )</em></li><li><strong>The code system code to filter for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_capacity__hsaId___product___code__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Deletion successful.</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__capacity_findexpiring__withinDaysFromNow_"><span class="parent">/capacity</span>/findexpiring/{withinDaysFromNow}</a> <span class="methods"><a href="#_capacity_findexpiring__withinDaysFromNow__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__capacity_findexpiring__withinDaysFromNow_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Find all of of the care unit HSA id:s that have capacities that are expiring within the provided timeframe</p></div><div class="list-group"><div onclick="window.location.href = '#_capacity_findexpiring__withinDaysFromNow__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Find all of of the care unit HSA id:s that have capacities that are expiring within the provided timeframe</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_capacity_findexpiring__withinDaysFromNow__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/capacity</span>/findexpiring/{withinDaysFromNow}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Find all of of the care unit HSA id:s that have capacities that are expiring within the provided timeframe</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_capacity_findexpiring__withinDaysFromNow__get_request" data-toggle="tab">Request</a></li><li><a href="#_capacity_findexpiring__withinDaysFromNow__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_capacity_findexpiring__withinDaysFromNow__get_request"><h3>URI Parameters</h3><ul><li><strong>Within days from now</strong>: <em>required (integer )</em></li></ul></div><div class="tab-pane" id="_capacity_findexpiring__withinDaysFromNow__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of UnitIds",
  "properties": {
    "values": { 
      "type": "array",
      "items": { "type": "string" }
    },
    "empty": { "type": "boolean", "required": false }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
    "values": [
      "SE2321000016-1HF3",
      "SE2321000016-6Fw9"
    ],
    "empty":false
}</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#_capacity">CapacityService</a></li></ul></div></div></div></div></body></html>